RPATH Fix for portable_lib Python Extension #14422

GregoryComer · 2025-09-18T22:32:52Z

Note: This is an attempt to cherry-pick Mergen's RPATH fix from #13254 onto main. Fixes #14421. Original description below.

Problem: The _portable_lib.so Python extension built on CI couldn't find PyTorch libraries when installed locally because it had hardcoded absolute paths from
the CI build environment.

Error:
ImportError: dlopen(.../_portable_lib.cpython-311-darwin.so, 0x0002): Library not loaded: @rpath/libtorch_python.dylib
Referenced from:
.../executorch/extension/pybindings/_portable_lib.cpython-311-darwin.so Reason: tried:
'/Users/runner/work/_temp/.../torch/lib/libtorch_python.dylib' (no such file)

Root Cause: The CMake build was linking to PyTorch libraries using absolute paths from the build environment, without setting proper relative RPATHs for
runtime library resolution.

Solution: Added platform-specific relative RPATH settings to the portable_lib target in /Users/mnachin/executorch/CMakeLists.txt (lines 657-669):

macOS: Uses @loader_path/../../../torch/lib to find PyTorch libraries relative to the .so file location
Linux: Uses $ORIGIN/../../../torch/lib for the same purpose
Sets both BUILD_RPATH and INSTALL_RPATH to ensure consistency

Impact: This allows the wheel-packaged _portable_lib.so to find PyTorch libraries regardless of the installation location, fixing the runtime linking issue
when using ExecutorTorch wheels built on CI.

Note: The same fix may be needed for _training_lib if it experiences similar issues.

Test Plan:

  # Build the wheel locally
  python setup.py bdist_wheel

  # create fresh conda env
  conda create -yn executorch_test_11 python=3.11.0 && conda activate executorch_test_11

  # install
  pip install ./dist/executorch-*.whl

  # Verify
  python -c "from executorch.extension.pybindings._portable_lib import _load_for_executorch; print('Success!')"

pytorch-bot · 2025-09-18T22:32:57Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/14422

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 2 New Failures, 1 Unrelated Failure

As of commit 446d855 with merge base 0f22062 ():

NEW FAILURES - The following jobs have failed:

pull / test-samsung-models-linux / linux-job (gh)
RuntimeError: Command docker exec -t 716bdad425ec555c786ecbd46b649d853ca785b99ea28d6667520be2c611eff3 /exec failed with exit code 1
trunk / unittest-release / macos / macos-job (gh)
backends/xnnpack/test/ops/test_conv1d.py::TestConv1d::test_qs8_conv1d_batchnorm_seq

BROKEN TRUNK - The following job failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

trunk / unittest-release / linux / linux-job (gh) (trunk failure)
[ FAILED ] LoggingTest.Utf8Truncation

This comment was automatically generated by Dr. CI and updates every 15 minutes.

github-actions · 2025-09-18T22:33:33Z

This PR needs a `release notes:` label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

abhinaykukkadapu · 2025-09-18T22:43:12Z

CMakeLists.txt

+      BUILD_RPATH "@loader_path/../../../torch/lib"
+      INSTALL_RPATH "@loader_path/../../../torch/lib"
+    )
+  else()


@GregoryComer Do you think this will work for windows?

That's a good question. I was planning to test the windows wheel on a local machine. I'll see if we run into any issues.

GregoryComer · 2025-09-19T00:30:09Z

Fixing lint. Other than that, CI looks good. I took a look at the previous cherry-pick attempt to main (#13290) and it looks like the build failures were due to CMake export changes. That's resolved now.

RPATH Fix for portable_lib Python Extension Problem: The _portable_lib.so Python extension built on CI couldn't find PyTorch libraries when installed locally because it had hardcoded absolute paths from the CI build environment. Error: ImportError: dlopen(.../_portable_lib.cpython-311-darwin.so, 0x0002): Library not loaded: @rpath/libtorch_python.dylib Referenced from: .../executorch/extension/pybindings/_portable_lib.cpython-311-darwin.so Reason: tried: '/Users/runner/work/_temp/.../torch/lib/libtorch_python.dylib' (no such file) Root Cause: The CMake build was linking to PyTorch libraries using absolute paths from the build environment, without setting proper relative RPATHs for runtime library resolution. Solution: Added platform-specific relative RPATH settings to the portable_lib target in /Users/mnachin/executorch/CMakeLists.txt (lines 657-669): - macOS: Uses @loader_path/../../../torch/lib to find PyTorch libraries relative to the .so file location - Linux: Uses $ORIGIN/../../../torch/lib for the same purpose - Sets both BUILD_RPATH and INSTALL_RPATH to ensure consistency Impact: This allows the wheel-packaged _portable_lib.so to find PyTorch libraries regardless of the installation location, fixing the runtime linking issue when using ExecutorTorch wheels built on CI. Note: The same fix may be needed for _training_lib if it experiences similar issues. Test Plan: ``` # Build the wheel locally python setup.py bdist_wheel # create fresh conda env conda create -yn executorch_test_11 python=3.11.0 && conda activate executorch_test_11 # install pip install ./dist/executorch-*.whl # Verify python -c "from executorch.extension.pybindings._portable_lib import _load_for_executorch; print('Success!')" ```

mergennachin · 2025-09-19T14:53:39Z

Thank you!

GregoryComer · 2025-09-19T18:33:06Z

I verified that the wheel built from this job, installed into a clean env, can load pybindings on macos.

I also tested on Windows on a clean env, and I can't load the _portable_lib dll, though it's also broken on the release branch. I'll file as release blocking task.

GregoryComer · 2025-09-19T18:34:57Z

@pytorchbot cherry-pick --onto release/1.0 -c critical

**Note: This is an attempt to cherry-pick Mergen's RPATH fix from #13254 onto main. Fixes #14421. Original description below.** Problem: The _portable_lib.so Python extension built on CI couldn't find PyTorch libraries when installed locally because it had hardcoded absolute paths from the CI build environment. Error: ImportError: dlopen(.../_portable_lib.cpython-311-darwin.so, 0x0002): Library not loaded: @rpath/libtorch_python.dylib Referenced from: .../executorch/extension/pybindings/_portable_lib.cpython-311-darwin.so Reason: tried: '/Users/runner/work/_temp/.../torch/lib/libtorch_python.dylib' (no such file) Root Cause: The CMake build was linking to PyTorch libraries using absolute paths from the build environment, without setting proper relative RPATHs for runtime library resolution. Solution: Added platform-specific relative RPATH settings to the portable_lib target in /Users/mnachin/executorch/CMakeLists.txt (lines 657-669): - macOS: Uses @loader_path/../../../torch/lib to find PyTorch libraries relative to the .so file location - Linux: Uses $ORIGIN/../../../torch/lib for the same purpose - Sets both BUILD_RPATH and INSTALL_RPATH to ensure consistency Impact: This allows the wheel-packaged _portable_lib.so to find PyTorch libraries regardless of the installation location, fixing the runtime linking issue when using ExecutorTorch wheels built on CI. Note: The same fix may be needed for _training_lib if it experiences similar issues. Test Plan: ``` # Build the wheel locally python setup.py bdist_wheel # create fresh conda env conda create -yn executorch_test_11 python=3.11.0 && conda activate executorch_test_11 # install pip install ./dist/executorch-*.whl # Verify python -c "from executorch.extension.pybindings._portable_lib import _load_for_executorch; print('Success!')" ``` Co-authored-by: Mergen Nachin <[email protected]> (cherry picked from commit 641e737)

pytorchbot · 2025-09-19T18:37:21Z

Cherry picking #14422

The cherry pick PR is at #14442 and it is recommended to link a critical cherry pick PR with an issue. The following tracker issues are updated:

[v1.0.0] Release Tracker #14288 (comment)

Details for Dev Infra team

Raised by workflow job

**Note: This is an attempt to cherry-pick Mergen's RPATH fix from #13254 onto main. Fixes #14421. Original description below.** Problem: The _portable_lib.so Python extension built on CI couldn't find PyTorch libraries when installed locally because it had hardcoded absolute paths from the CI build environment. Error: ImportError: dlopen(.../_portable_lib.cpython-311-darwin.so, 0x0002): Library not loaded: @rpath/libtorch_python.dylib Referenced from: .../executorch/extension/pybindings/_portable_lib.cpython-311-darwin.so Reason: tried: '/Users/runner/work/_temp/.../torch/lib/libtorch_python.dylib' (no such file) Root Cause: The CMake build was linking to PyTorch libraries using absolute paths from the build environment, without setting proper relative RPATHs for runtime library resolution. Solution: Added platform-specific relative RPATH settings to the portable_lib target in /Users/mnachin/executorch/CMakeLists.txt (lines 657-669): - macOS: Uses @loader_path/../../../torch/lib to find PyTorch libraries relative to the .so file location - Linux: Uses $ORIGIN/../../../torch/lib for the same purpose - Sets both BUILD_RPATH and INSTALL_RPATH to ensure consistency Impact: This allows the wheel-packaged _portable_lib.so to find PyTorch libraries regardless of the installation location, fixing the runtime linking issue when using ExecutorTorch wheels built on CI. Note: The same fix may be needed for _training_lib if it experiences similar issues. Test Plan: ``` # Build the wheel locally python setup.py bdist_wheel # create fresh conda env conda create -yn executorch_test_11 python=3.11.0 && conda activate executorch_test_11 # install pip install ./dist/executorch-*.whl # Verify python -c "from executorch.extension.pybindings._portable_lib import _load_for_executorch; print('Success!')" ``` Co-authored-by: Mergen Nachin <[email protected]> (cherry picked from commit 641e737)

**Note: This is an attempt to cherry-pick Mergen's RPATH fix from pytorch#13254 onto main. Fixes pytorch#14421. Original description below.** Problem: The _portable_lib.so Python extension built on CI couldn't find PyTorch libraries when installed locally because it had hardcoded absolute paths from the CI build environment. Error: ImportError: dlopen(.../_portable_lib.cpython-311-darwin.so, 0x0002): Library not loaded: @rpath/libtorch_python.dylib Referenced from: .../executorch/extension/pybindings/_portable_lib.cpython-311-darwin.so Reason: tried: '/Users/runner/work/_temp/.../torch/lib/libtorch_python.dylib' (no such file) Root Cause: The CMake build was linking to PyTorch libraries using absolute paths from the build environment, without setting proper relative RPATHs for runtime library resolution. Solution: Added platform-specific relative RPATH settings to the portable_lib target in /Users/mnachin/executorch/CMakeLists.txt (lines 657-669): - macOS: Uses @loader_path/../../../torch/lib to find PyTorch libraries relative to the .so file location - Linux: Uses $ORIGIN/../../../torch/lib for the same purpose - Sets both BUILD_RPATH and INSTALL_RPATH to ensure consistency Impact: This allows the wheel-packaged _portable_lib.so to find PyTorch libraries regardless of the installation location, fixing the runtime linking issue when using ExecutorTorch wheels built on CI. Note: The same fix may be needed for _training_lib if it experiences similar issues. Test Plan: ``` # Build the wheel locally python setup.py bdist_wheel # create fresh conda env conda create -yn executorch_test_11 python=3.11.0 && conda activate executorch_test_11 # install pip install ./dist/executorch-*.whl # Verify python -c "from executorch.extension.pybindings._portable_lib import _load_for_executorch; print('Success!')" ``` Co-authored-by: Mergen Nachin <[email protected]>

GregoryComer requested review from abhinaykukkadapu, mergennachin and psiddh September 18, 2025 22:32

meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 18, 2025

GregoryComer added ciflow/binaries ciflow/binaries/all Release PRs with this label will build wheels for all python versions labels Sep 18, 2025

abhinaykukkadapu reviewed Sep 18, 2025

View reviewed changes

GregoryComer marked this pull request as ready for review September 19, 2025 00:30

GregoryComer requested review from kirklandsign and larryliu0820 as code owners September 19, 2025 00:30

GregoryComer force-pushed the fix-rpath branch from 2c4f7ba to 446d855 Compare September 19, 2025 00:31

mergennachin approved these changes Sep 19, 2025

View reviewed changes

GregoryComer merged commit 641e737 into pytorch:main Sep 19, 2025
276 of 279 checks passed

pytorchbot mentioned this pull request Sep 19, 2025

[v1.0.0] Release Tracker #14288

Open

GregoryComer mentioned this pull request Sep 19, 2025

Pybindings can't load on Windows when installing wheel #14443

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

RPATH Fix for portable_lib Python Extension #14422

RPATH Fix for portable_lib Python Extension #14422

Uh oh!

GregoryComer commented Sep 18, 2025 •

edited

Loading

Uh oh!

pytorch-bot bot commented Sep 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

abhinaykukkadapu Sep 18, 2025

Uh oh!

GregoryComer Sep 18, 2025

Uh oh!

GregoryComer commented Sep 19, 2025

Uh oh!

mergennachin commented Sep 19, 2025

Uh oh!

GregoryComer commented Sep 19, 2025

Uh oh!

Uh oh!

GregoryComer commented Sep 19, 2025

Uh oh!

pytorchbot commented Sep 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RPATH Fix for portable_lib Python Extension #14422

RPATH Fix for portable_lib Python Extension #14422

Uh oh!

Conversation

GregoryComer commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/14422

❌ 2 New Failures, 1 Unrelated Failure

Uh oh!

github-actions bot commented Sep 18, 2025

This PR needs a release notes: label

Uh oh!

abhinaykukkadapu Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

GregoryComer Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

GregoryComer commented Sep 19, 2025

Uh oh!

mergennachin commented Sep 19, 2025

Uh oh!

GregoryComer commented Sep 19, 2025

Uh oh!

Uh oh!

GregoryComer commented Sep 19, 2025

Uh oh!

pytorchbot commented Sep 19, 2025

Cherry picking #14422

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GregoryComer commented Sep 18, 2025 •

edited

Loading

pytorch-bot bot commented Sep 18, 2025 •

edited

Loading

This PR needs a `release notes:` label